search

k-john-gough / gpcp

Gardens Point Component Pascal is an implementation of the Component Pascal Language (CP). There are implementations for both the CLR and the JVM.
Other
59 stars 16 forks source link

Need build docs #4

Open blakemcbride opened 7 years ago

blakemcbride commented 7 years ago

It would be great if README.md pointed us to a BUILD.txt file.

Some rough usage docs would be great too.

k-john-gough commented 7 years ago

Sorry, I am a bit of a newbie to github. So far I have migrated and updated all the documentation from the now defunct CodePlex. The distributions have GettingStarted, ReleaseNotes and ChangeLog, about 100 pages of pdf. The v1.4.x versions of the ReleaseNotes have a whole chapter on rebuilding the tools from source, by several different methods. As for example programs, there are about twenty in documentation/examples, the another 50k LOC in the sources.

Since gpcp is a programming language compiler, written in its own language, the source repository does not stand alone. You cannot build or use the tools unless you already have the executable files from the distribution (and then necessarily will have all the documentation as well).

Having said all that, I am open to any advice on how to make gpcp more useful to its users now that it is in its new home.

blakemcbride commented 7 years ago

Thanks for the reply. I built gpcp some time ago but don't remember what I did. I usually keep notes on stuff like this. Since I can't build without a pre-built executable, I suggest you include those executables in the github repository. I would just create a directory named executables off of the root, and under there I would have directories for each platform. There shouldn't be any need for history (other than what git normally keeps). Also, you need not update the executables each time you make a change. The executables only have to be good enough for the bootstrap process.

Once it becomes buildable, I would be happy to give it a try and provide feedback.

Thanks!

Blake