Permalink
Browse files

updated README with installation instructions

  • Loading branch information...
Fazal Majid
Fazal Majid committed Mar 6, 2017
1 parent 2891212 commit a6de8a58eca08774f04db5a73c011eabac02aabc
Showing with 15 additions and 3 deletions.
  1. +3 −0 Makefile
  2. +12 −3 README.md
View
@@ -61,6 +61,9 @@ opml:
wget -c https://majid.info/temboz/temboz.opml
mv temboz.opml me.opml
+sdist:
+ python setup.py sdist
+
distclean:
-rm -f core *.pyc *~ pages/*~ *.old pages/*.py pages/*.pyc ChangeLog*
-find . -name .\#\* -exec rm {} \;
View
@@ -48,9 +48,18 @@ You can check outstanding bug reports, change requests and more on the [GitHub i
## Installation
-You will need Python 2.7 installed on your machine.
-
-(more complete installations with pip and virtualenv to follow)
+* You will need Python 2.7 installed on your machine.
+* If you do not have `pip`, install it by running `python -m ensurepip` (you may need to do this as root depending on how your Python installation is set up).
+* If you do not have virtualenv installed, install it using `pip install virtualenv`
+* Create a directory and virtualenv to run Temboz, in this case `tembozdir`: `virtualenv tembozdir`
+* `cd tembozdir`
+ * If you are a bash/ksh user: `. bin/activate`
+ * If you are a tcsh/csh user: `source bin/activate.csh`
+* Install Temboz in the virtualenv: `pip install temboz`
+* When you run Temboz for the first time, it will prompt you for the network address/port it should listen on, and your login/password: `./bin/temboz`
+* Optionally, you can import an OPML subscription file if you have one: `./bin/temboz --import foo.opml`
+* If you imported subscriptions, you can trigger a manual refresh: `./bin/temboz --refresh`
+* You can now start the Temboz server: `./bin/temboz --server`
## Credits

0 comments on commit a6de8a5

Please sign in to comment.