Skip to content

Commit

Permalink
initial readme upload
Browse files Browse the repository at this point in the history
the readme will change with github relevant information
  • Loading branch information
phpchess committed Mar 10, 2014
0 parents commit f9458f4
Show file tree
Hide file tree
Showing 3 changed files with 288 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .gitattributes
@@ -0,0 +1,22 @@
# Auto detect text files and perform LF normalization
* text=auto

# Custom for Visual Studio
*.cs diff=csharp
*.sln merge=union
*.csproj merge=union
*.vbproj merge=union
*.fsproj merge=union
*.dbproj merge=union

# Standard to msysgit
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain
215 changes: 215 additions & 0 deletions .gitignore
@@ -0,0 +1,215 @@
#################
## Eclipse
#################

*.pydevproject
.project
.metadata
bin/
tmp/
*.tmp
*.bak
*.swp
*~.nib
local.properties
.classpath
.settings/
.loadpath

# External tool builders
.externalToolBuilders/

# Locally stored "Eclipse launch configurations"
*.launch

# CDT-specific
.cproject

# PDT-specific
.buildpath


#################
## Visual Studio
#################

## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.

# User-specific files
*.suo
*.user
*.sln.docstates

# Build results

[Dd]ebug/
[Rr]elease/
x64/
build/
[Bb]in/
[Oo]bj/

# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*

*_i.c
*_p.c
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.log
*.scc

# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opensdf
*.sdf
*.cachefile

# Visual Studio profiler
*.psess
*.vsp
*.vspx

# Guidance Automation Toolkit
*.gpState

# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper

# TeamCity is a build add-in
_TeamCity*

# DotCover is a Code Coverage Tool
*.dotCover

# NCrunch
*.ncrunch*
.*crunch*.local.xml

# Installshield output folder
[Ee]xpress/

# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html

# Click-Once directory
publish/

# Publish Web Output
*.Publish.xml
*.pubxml

# NuGet Packages Directory
## TODO: If you have NuGet Package Restore enabled, uncomment the next line
#packages/

# Windows Azure Build Output
csx
*.build.csdef

# Windows Store app package directory
AppPackages/

# Others
sql/
*.Cache
ClientBin/
[Ss]tyle[Cc]op.*
~$*
*~
*.dbmdl
*.[Pp]ublish.xml
*.pfx
*.publishsettings

# RIA/Silverlight projects
Generated_Code/

# Backup & report files from converting an old project file to a newer
# Visual Studio version. Backup files are not needed, because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm

# SQL Server files
App_Data/*.mdf
App_Data/*.ldf

#############
## Windows detritus
#############

# Windows image file caches
Thumbs.db
ehthumbs.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Mac crap
.DS_Store


#############
## Python
#############

*.py[co]

# Packages
*.egg
*.egg-info
dist/
build/
eggs/
parts/
var/
sdist/
develop-eggs/
.installed.cfg

# Installer logs
pip-log.txt

# Unit test / coverage reports
.coverage
.tox

#Translations
*.mo

#Mr Developer
.mr.developer.cfg
51 changes: 51 additions & 0 deletions readme
@@ -0,0 +1,51 @@
Welcome to release 4.2.1
========================

This software is provided under the GNU Affero General Public License,
the terms of which can be referenced here: https://www.gnu.org/licenses/agpl.html

We are asking you to be please give phpChess and its contributers credit when using, distributing, modifying otherwise working with the software.

please ensure you read the intro.rtf, and visit http://www.phpchess.com/?page_id=425 - which is the installation and upgrade Q&A


Quick Installation step for phpChess:
=====================================

a) copy all files and folders to you server using your favourite ftp program
!!!!IMPORTANT!!!!
b) rename the bin/config.txt file to config.php
!!!!IMPORTANT!!!!
c) Using a browser and open the installtion file http:///www.[your server address]/phpchess/install/
d) follow the instructions

Quick upgrade guide (4.1 or higher):
====================================

a) copy all files over the existing files using your favourite ftp program
b) using your browser open the upgrade file http://www.[your server address]/phpchess/install/upgrade.php
c) follow the instructions


from a phpChess version older than 4.1:
=======================================

!!!! Please note that older games will be automatically finished as new fields are added to the database!!!!

a) make a back-up of all your phpChess files on the server! - especially bin/config.php
b) make sure you delete all existing phpChess files from the server!!!
c) once you have copied the new files onto the server
--> copy from your back-up the config.php file from the bin directory back to the server into the bin directory
--> rename the file bin/installed.old to bin/installed.txt
d) now you can go on your server and open the install directory in your browser.



If you upgrade without these steps you will get issues and you will likely waste additional time.

If you are installing phpChess new, there are no such issues to worry about.


Have fun, all the best

phpChess.com (c)phpchess 2001 - 2014

0 comments on commit f9458f4

Please sign in to comment.