diff --git a/README.HACKING.md b/README.HACKING.md new file mode 100644 index 0000000000000000000000000000000000000000..663d8d49df4e60c1be8868e489b144711b0c2cc1 --- /dev/null +++ b/README.HACKING.md @@ -0,0 +1,32 @@ +# Readme for hacking on the source + +## Build systems +The build system of I2P today is a bit mixed. +In the old days, and at least for relasing we actually use +the old `ant` tool. For the new Browser Bundle launcher, as +well as the Mac OSX launcher the `sbt` tool from the Scala +world was used cause it gives some increadibly effictive plugins +and logic to build them while keeping a relation to the old build +system. + +We also have Gradle partly implemented, much work, but not all. Meeh +which is writing this readme is guessing we'll end up with a combination +of Gradle and SBT in the end when we know what kind of structure we want. + + +## Browsing around the source code + +If you're new at this, which we all was at one point, I'll have some tips. + +* Check out our [README.DIRECTORIES.md](README.DIRECTORIES.md) to learn ore +about where you'll find I2P's different parts in the codebase. + +* For me (Meeh), it worked well to run `find . -type f -name '*Runner.java'` +from the source tree root, and take a look at the files that get listed. A lot +of hints of how this is peaced together lies there. + + +## The .. Monotone part + +Check out [README.MONOTONECHEATSHEET.md](README.MONOTONECHEATSHEET.md) file. + diff --git a/README.MONOTONECHEATSHEET.md b/README.MONOTONECHEATSHEET.md new file mode 100644 index 0000000000000000000000000000000000000000..a56d94052a2004b74337c95a73e0c8283b14abc1 --- /dev/null +++ b/README.MONOTONECHEATSHEET.md @@ -0,0 +1,30 @@ +# Monotone cheatsheet + +**Slogan:** *Saving you hours reading old manuals* + +For most of us developers using git, one of the columns will have an example of +how certain things are done in git, to easier know what to do in monotone. + +## Commands + +Command | Git cmd (which give same info) | Description + ------ | ----------------------------- | ------------ +`mtn ls unknown` | `git status` | List untracked files. +`mtn status` | `git status` | List untracked files. (Please note that `mtn status` do NOT list unknown files.) +`mtn mv [src] [dest]` | `git mv [src] [dest]` | Move a traced directory or file. +`mtn add -R [files..]` | `git add [files..]` | Adds a file to the workspace. Please use -R when it's directories. +`mtn ci [-k devkey] [files..]` | `git commit -s [files...]` | Sign and commit a patch. +`mtn -d [mtndb] pull [-k devkey] [server]` | `git pull [servername] [branchname]` | Pulls new patches from a remote server. +`mtn -d [mtndb] push [-k devkey] [server]` | `git push [servername] [branchname]` | Pushes your patches to a remote server. +`mtn update -r t:TAGNAME` | `git checkout TAGNAME` | Check out an tag in current working directory. +`mtn list tag` | `git tag -l` | List tags in the repo. +`mtn di -r t:TAGNAME` | `git diff TAGNAME` | Show you the diff between the choosen tag and current head. + +TBA... + +Contributions are welcome! + + + + + diff --git a/README.md b/README.md index 06abba8f6e6137ce4337823e8d8239ad1314317b..a62397d578f754f6e5378a8b180cd07e589df0cd 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,10 @@ FAQ: https://geti2p.net/faq API: http://docs.i2p-projekt.de/javadoc/ or run 'ant javadoc' then start at build/javadoc/index.html +## How to contribute / Hack on I2P + +Please check out [README.HACKING.md](README.HACKING.md) + ## Building packages from source To get development branch from source control: https://geti2p.net/newdevelopers