From 5e18b4268e9ce0b81c82a7b6d9bba6245bf660c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20H=C3=BCrlimann=20=28CyT=29?= Date: Fri, 8 May 2015 21:00:16 +0200 Subject: [PATCH] Port docs to markdown with some updates. --- INSTALL.md | 70 +++++++++++++++++++++++++++++++++++++++++++ INSTALL.textile | 80 ------------------------------------------------- README.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++++ README.textile | 62 -------------------------------------- UPGRADE.md | 41 +++++++++++++++++++++++++ UPGRADE.textile | 47 ----------------------------- 6 files changed, 190 insertions(+), 189 deletions(-) create mode 100644 INSTALL.md delete mode 100644 INSTALL.textile create mode 100644 README.md delete mode 100644 README.textile create mode 100644 UPGRADE.md delete mode 100644 UPGRADE.textile diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 00000000..959aa0d6 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,70 @@ +We currently support installing on Debian 5.0 Lenny and Ubuntu 12.04 +systems. + +Install Ruby’n’Rails +-------------------- + +Bookyt is developed and tested using Rails 3.2 and Ruby 1.9.3. + +Install packages needed: + + sudo apt-get install rubygems irb libruby-extras libxml2-dev libxslt-dev ruby-dev build-essential + sudo apt-get install git + +Then some gems: + + sudo gem install rake bundler + +Testing +------- + +You currently need phantomjs version 1.8.1 or newer. You can get this on +Ubuntu 13.10. + +Install Bookyt +-------------- + +Install current Bookyt from git repository. We’ll use this checkout as +working directory from now on: + + git clone http://github.com/huerlisi/bookyt.git + cd bookyt + +Install dependency gems: + + bundle + +Setup database: + +Copy database.yml.example to database.yml and edit as needed. + + cp config/database.yml.example config/database.yml + +Initialize the database: + + bundle exec rake db:setup + +Setup admin user +---------------- + +There’s a rake task to setup an admin user: + + bundle exec rake users:admin + +Create account types +-------------------- + +Account types need to be named correctly for calculation of the balance +sheet and profit sheet. + +See db/seeds/locales for your convenience. + +### Run + +You should now be able to start Bookyt: + + rails server + +Bookyt is now available at http://localhost:3000 + +Enjoy! diff --git a/INSTALL.textile b/INSTALL.textile deleted file mode 100644 index 4e326778..00000000 --- a/INSTALL.textile +++ /dev/null @@ -1,80 +0,0 @@ -We currently support installing on Debian 5.0 Lenny and Ubuntu 12.04 systems. - -h2. Install Ruby'n'Rails - -Bookyt is developed and tested using Rails 3.2 and Ruby 1.9.3. - -Install packages needed: - -
-sudo apt-get install rubygems irb libruby-extras libxml2-dev libxslt-dev ruby-dev build-essential
-sudo apt-get install git
-
- -Then some gems: -
-sudo gem install rake bundler
-
- -h2. Testing - -You currently need phantomjs version 1.8.1 or newer. You can get this on Ubuntu 13.10. - -h2. Install Bookyt - -Install current Bookyt from git repository. We'll use this checkout as working directory from now on: - -
-git clone http://github.com/huerlisi/bookyt.git
-cd bookyt
-
- -Install dependency gems: - -
-bundle
-
- -Setup database: - -Copy database.yml.example to database.yml and edit as needed. - -
-cp config/database.yml.example config/database.yml
-
- -Initialize the database: - -
-bundle exec rake db:setup
-
- - -h2. Setup admin user - -There's a rake task to setup an admin user: - -
-bundle exec rake users:admin
-
- - -h2. Create account types - -Account types need to be named correctly for calculation of the balance sheet -and profit sheet. - -See db/seeds/locales for your convenience. - - -h3. Run - -You should now be able to start Bookyt: - -
-rails server
-
- -Bookyt is now available at http://localhost:3000 - -Enjoy! diff --git a/README.md b/README.md new file mode 100644 index 00000000..8bc95455 --- /dev/null +++ b/README.md @@ -0,0 +1,79 @@ +Bookyt +====== + +Bookyt is a bookkeeping/ERP application designed for +small-to-medium-sized companies. + +It can handle debit invoices, credit invoices, projects with timelogs, +swiss salary management, and much more. + +Demo +---- + +Here you find a demo installation of +[Bookyt](http://bookyt.demo.cyt.ch). + +Features +-------- + +Bookyt is a web application implementing double-entry bookkeeping +providing: + +We try stick with the slogan ‘Keep it simple, stupid’. The interface +follows modern industrial design rules. All pages try to give you just +enough information to do the task while being simple. Dynamic elements +such as inline editing are used sparsely, but are there where +appreciated. + +- Customizable accounts +- Booking wizard +- Booking templates +- Earnings report +- Balance sheet +- Invoicing +- Accounts Receivable +- Accounts Payable +- Employee expense voucher +- Depreciation +- Setting up tax tables + +Find more information about Bookyt on its [homepage](http://bookyt.ch) + +Bookyt is built on [Ruby On Rails](http://www.rubyonrails.org) and +released as [Open Source](http://www.opensource.org). + +Documentation +------------- + +- [Installation](https://github.com/huerlisi/bookyt/blob/master/INSTALL.md) +- [Upgrade](https://github.com/huerlisi/bookyt/blob/master/UPGRADE.md) + +Contributing +------------ + +- [Travis CI](https://travis-ci.org/huerlisi/bookyt.png) +- [CodeClimate](https://codeclimate.com/github/huerlisi/bookyt.png) + +Code is available at [github](https://github.com/huerlisi/bookyt). + +License +------- + + Copyright 2007-2015 Simon Hürlimann + Copyright 2010-2012 Ramon Egloff + Copyright 2010-2012 Roman Simecek + Copyright 2011-2013 Andi Staub + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + diff --git a/README.textile b/README.textile deleted file mode 100644 index 73762126..00000000 --- a/README.textile +++ /dev/null @@ -1,62 +0,0 @@ -h1. Bookyt - -Bookyt is a bookkeeping/ERP application designed for small-to-medium-sized companies. - -It can handle debit invoices, credit invoices, projects with timelogs, swiss salary management, and much more. - -h2. Demo - -Here you find a demo installation of "Bookyt":http://bookyt.demo.cyt.ch. - -h2. About Bookyt - -Bookyt is a web application implementing double-entry bookkeeping providing: - -* Customizable accounts -* Booking wizard -* Booking templates -* Earnings report -* Balance sheet -* Invoicing -* Accounts Receivable -* Accounts Payable -* Employee expense voucher -* Depreciation -* Setting up tax tables - -Find more information about Bookyt on its "homepage":http://bookyt.ch - -Bookyt is built on "Ruby On Rails":http://www.rubyonrails.org and released as "Open Source":http://www.opensource.org. - -h2. Documentation - -* "Installation":https://github.com/huerlisi/bookyt/blob/master/INSTALL.textile - -h2. Contributing - -!https://travis-ci.org/huerlisi/bookyt.png!:https://travis-ci.org/huerlisi/bookyt -!https://codeclimate.com/github/huerlisi/bookyt.png!:https://codeclimate.com/github/huerlisi/bookyt - -Code is available at "github":https://github.com/huerlisi/bookyt. - -Issue tracking is done using "Redmine":https://redmine.cyt.ch/projects/bookyt/issues. - -h2. License - -Copyright 2007-2014 Simon Hürlimann -Copyright 2010-2012 Ramon Egloff -Copyright 2010-2012 Roman Simecek -Copyright 2011-2013 Andi Staub - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Affero General Public License as -published by the Free Software Foundation, either version 3 of the -License, or (at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License for more details. - -You should have received a copy of the GNU Affero General Public License -along with this program. If not, see . diff --git a/UPGRADE.md b/UPGRADE.md new file mode 100644 index 00000000..8f002cff --- /dev/null +++ b/UPGRADE.md @@ -0,0 +1,41 @@ +Upgrade from Bookyt 1.5 to 2.0 +============================== + +Bookyt 2.0 uses a different database system and supports multi tenancy. +This makes some manual steps necessary. Follow these instruction to enjoy all +the new features of Bookyt 2.0. + +If you do not yet run the latest Bookyt 1.x release, please first +upgrade to release 1.5. It is available on github in the stable-1-5 branch. + +Backup Data +----------- + + bundle exec rails runner 'Backup.dump("upgrade-to-2.0.zip")' + +Create PostgreSQL database +-------------------------- + +This is how it’s done on Debian/Ubuntu. Please submit a patch if you’ve +figured out the steps on another system. + + sudo apt-get install postgresql + + sed 's/\*mysql/*postgres/' -i 'config/database.yml' + +Lookup current username, password and database from config/database.yml +and use them in the following commands. + + sudo -u postgres -i + createuser $USER_NAME --no-createdb --no-createrole --no-superuser --pwprompt + createdb --owner $USER_NAME $DATABASE_NAME + +On a development system, you probably also want to do the steps for +both the development and test databases. + +Restore Data +------------ + +Now import the data again. + + bundle exec rails runner 'Backup.restore "upgrade-to-2.0.zip"' diff --git a/UPGRADE.textile b/UPGRADE.textile deleted file mode 100644 index 963aa60f..00000000 --- a/UPGRADE.textile +++ /dev/null @@ -1,47 +0,0 @@ -h1. Upgrade from Bookyt 1.5 to 2.0 - -Bookyt 2.0 uses a different database system and supports multi tenancy. This -makes some manual steps necessary. Follow these instruction to enjoy all the -new features of Bookyt 2.0. - -If you do not yet run the latest Bookyt 1.x release, please first upgrade to -release 1.5. It is available on github in the stable-1-5 branch. - -h2. Backup Data - -
-bundle exec rails runner 'Backup.dump("upgrade-to-2.0.zip")'
-
- -h2. Create PostgreSQL database - -This is how it's done on Debian/Ubuntu. Please submit a patch if you've -figured out the steps on another system. - -
-sudo apt-get install postgresql
-
- -
-sed 's/\*mysql/*postgres/' -i 'config/database.yml'
-
- -Lookup current username, password and database from config/database.yml -and use them in the following commands. - -
-sudo -u postgres -i
-createuser $USER_NAME --no-createdb --no-createrole --no-superuser --pwprompt
-createdb --owner $USER_NAME $DATABASE_NAME
-
- -On a development system, you probably also want to do the steps for both -the development and test databases. - -h2. Restore Data - -Now import the data again. - -
-bundle exec rails runner 'Backup.restore "upgrade-to-2.0.zip"'
-