Browse Source

Add license file and skeleton of readme

J. King 1 year ago
parent
commit
9c65e31457
2 changed files with 49 additions and 0 deletions
  1. 22
    0
      LICENSE
  2. 27
    0
      README.md

+ 22
- 0
LICENSE View File

@@ -0,0 +1,22 @@
1
+Copyright (c) 2017 J. King, Dustin Wilson
2
+
3
+Permission is hereby granted, free of charge, to any person
4
+obtaining a copy of this software and associated documentation
5
+files (the "Software"), to deal in the Software without
6
+restriction, including without limitation the rights to use,
7
+copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+copies of the Software, and to permit persons to whom the
9
+Software is furnished to do so, subject to the following
10
+conditions:
11
+
12
+The above copyright notice and this permission notice shall be
13
+included in all copies or substantial portions of the Software.
14
+
15
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22
+OTHER DEALINGS IN THE SOFTWARE.

+ 27
- 0
README.md View File

@@ -0,0 +1,27 @@
1
+Arsse: Advanced RSS Environment
2
+===============================
3
+
4
+TODO: Fill in stuff
5
+
6
+License
7
+-------
8
+
9
+Arsse is made available under the permissive MIT license.  See the LICENSE file included with the distribution or source code for exact legal text. Dependencies included in the distribution may be governed by other licenses.
10
+
11
+Running tests
12
+-------------
13
+
14
+To run the test suite, you must have [Composer](https://getcomposer.org/) installed as well as the command-line PHP interpreter (this is normally required to use Composer). Port 8000 must also be available for use by the built-in PHP Web server.
15
+
16
+``` sh
17
+# first install dependencies
18
+composer install
19
+# run the tests
20
+./tests/test
21
+```
22
+
23
+The example uses Unix syntax, but the test suite also runs in Windows. By default all tests are run; you can pass the same arguments to the test runner [as you would to PHPUnit](https://phpunit.de/manual/current/en/textui.html#textui.clioptions):
24
+
25
+``` sh
26
+./tests/test --testsuite "Configuration"
27
+```

Loading…
Cancel
Save