update docs
This commit is contained in:
27
README.md
27
README.md
@ -63,13 +63,18 @@ Current version is 0.61. See [NEWS.md](https://github.com/breunigs/ingress-intel
|
||||
|
||||
[**INSTALL**](https://raw.github.com/breunigs/ingress-intel-total-conversion/gh-pages/dist/total-conversion-build.user.js)
|
||||
|
||||
Reporting Issues
|
||||
----------------
|
||||
|
||||
[tutorial / guide / please read / **free candy**](https://github.com/breunigs/ingress-intel-total-conversion/blob/gh-pages/HACKING.md#how-do-i-report-bugs-)
|
||||
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
Please do!
|
||||
|
||||
(Obviously, Resistance folks must send in complete patches while Enlightenment gals and guys may just open feature request ☺)
|
||||
(Obviously, Resistance folks must send in complete patches while Enlightenment gals and guys may just open feature request ☺). If you want to hack the source, please [read HACKING.md for details](https://github.com/breunigs/ingress-intel-total-conversion/blob/gh-pages/HACKING.md) .
|
||||
|
||||
**So far, these people have contributed:**
|
||||
|
||||
@ -90,26 +95,6 @@ Please do!
|
||||
[Xelio](https://github.com/Xelio),
|
||||
[ZauberNerd](https://github.com/ZauberNerd)
|
||||
|
||||
Hacking
|
||||
-------
|
||||
|
||||
Execute `./build.py` to effectively concatenate `main.js` with all the files in `code/`. It generates the user script which may be installed into your browser. Do not modify `ttic-debug.user.js` manually, because it is automatically generated. Instead, modify the files in `code/` and have that file built for you. The files in `dist/` are for release only and should not be touched by you.
|
||||
|
||||
`style.css` contains most styles required for the user-script. The extra ones can be found in `code/boot.js#window.setupStyles`. Only CSS rules that depend on config variables should be defined there.
|
||||
|
||||
`external/leaflet_google.js` contains some code to display Google Maps imagery with Leaflet, which is a slightly modified version [of this gist](https://gist.github.com/4504864). The code likely was originally written by Pavel Shramov.
|
||||
|
||||
`external/autolink.js` is the same file as distributed by Bryan Woods.
|
||||
|
||||
|
||||
My dev setup is like this:
|
||||
- checked out git repository
|
||||
- symlinked the user script to the version in the repo. It should work like this:
|
||||
- `cd ~/.mozilla/firefox/<YOUR FF PROFILE>/scriptish_scripts/ingress-intel-total-conversion@breunigs`
|
||||
- `ln -s ~/<PATH TO REPO>/total-conversion-build.user.js ingress-intel-total-conversion@breunigs.user.js`
|
||||
- if you are working on styles or scripts that are normally served via HTTP, you can setup an HTTP server for the current directory at `http://0.0.0.0:8000` using `python -m SimpleHTTPServer`.
|
||||
- run `./autobuild.sh` to re-build the user script whenever you make changes
|
||||
- Focus the location bar and hit enter instead of reloading. This way your browser doesn’t look for new versions of cached files.
|
||||
|
||||
Attribution & License
|
||||
---------------------
|
||||
|
Reference in New Issue
Block a user