Initial commit
[imapreorder.git] / INSTALL
1 Copyright © 2014 Iain Nicol
2 See the end of the file for license conditions.
3
4
5 To compile and use imapreorder you must first you must install sbt. sbt
6 is a build system for Scala programs.[1]
7
8 After installing sbt, open up a console in the root directory of the
9 imapreorder source code.
10
11 We should test imapreorder before proceeding. The tests should work on
12 GNU/Linux as long as you have the Dovecot IMAP server installed. You do
13 not need any Dovecot service to be running, nor will the tests interfere
14 with any emails or data you may be storing with Dovecot; the tests, of
15 course, are isolated.
16
17 To run the tests, run the command
18 $ sbt test
19 Tests may take a few minutes to pass. The good news is that, if they
20 were to instead fail, they would likely fail much faster than that.
21
22 You can compile and run imapreorder without installing it. For example,
23 run the command
24 $ sbt "run --host HOST --username USER --password PASS --folder FOLDER"
25 Obviously, substitute in the correct command line arguments.
26
27 [1] See <http://www.scala-sbt.org/index.html>.
28
29
30 \f
31 This program is free software: you can redistribute it and/or modify
32 it under the terms of the GNU Affero General Public License as published by
33 the Free Software Foundation, either version 3 of the License, or
34 (at your option) any lather version.
35
36 This program is distributed in the hope that it will be useful,
37 but WITHOUT ANY WARRANTY; without even the implied warranty of
38 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
39 GNU Affero General Public License for more details.
40
41 You should have received a copy of the GNU Affero General Public License
42 along with this program. If not, see <http://www.gnu.org/licenses/>.