Permalink
Browse files

Tidy up the readme a bit

  • Loading branch information...
1 parent ae1008e commit ccca66a96ee57894294a7142924d5c260ab64260 @ocean90 ocean90 committed Jan 31, 2017
Showing with 9 additions and 12 deletions.
  1. +1 −1 .github/CONTRIBUTING.md
  2. BIN .github/banner.png
  3. +8 −11 README.md
@@ -56,7 +56,7 @@ You can run PHPUnit on Unix or Windows, however at this time instructions and sc
To run the unit tests on a Unix machine, open a command shell, change to your development directory for GlotPress and run:
```
-./tests/bin/run-unittests.sh
+$ ./tests/phpunit/bin/run-unittests.sh -d testdb_name [ -u dbuser ] [ -p dbpassword ] [ -h dbhost ] [ -x dbprefix ] [ -w wpversion ] [ -D (drop-db) ] [ -c coverage_file ] [ -f phpunit_filter ]
```
To write unit tests, find the relevant file that has similar tests already in them (they are named accordingly), and add the tests there. If there isn't a file that has tests for the functionality you've written, create a new file, and name it `test_<functionality>.php`. PHPUnit will pick up the file automatically. Refer to the [PHPUnit documentation](https://phpunit.de/manual/4.5/en/index.html) and existing files for how to write new tests.
View
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
@@ -1,9 +1,11 @@
+![GlotPress](.github/banner.png)
+
+[![Build Status](https://travis-ci.org/GlotPress/GlotPress-WP.svg?branch=develop)](https://travis-ci.org/GlotPress/GlotPress-WP) [![codecov.io](https://codecov.io/github/GlotPress/GlotPress-WP/coverage.svg?branch=develop)](https://codecov.io/github/GlotPress/GlotPress-WP?branch=develop) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/GlotPress/GlotPress-WP/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/GlotPress/GlotPress-WP/?branch=develop)
+
# GlotPress
GlotPress is a WordPress plugin to let you set up your own collaborative, web-based software translation tool.
-[![Build Status](https://travis-ci.org/GlotPress/GlotPress-WP.svg?branch=develop)](https://travis-ci.org/GlotPress/GlotPress-WP) [![codecov.io](https://codecov.io/github/GlotPress/GlotPress-WP/coverage.svg?branch=develop)](https://codecov.io/github/GlotPress/GlotPress-WP?branch=develop) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/GlotPress/GlotPress-WP/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/GlotPress/GlotPress-WP/?branch=develop)
-
## Contributing
Many open source projects span regions, countries and dialects and need to support a variety of translations, GlotPress is here to help you collaborate online with your translators to ensure your users see your software in their native language.
@@ -24,26 +26,21 @@ Search for "GlotPress" in the WordPress.org plugin directory and install it.
After activating the plugin, GlotPress can be accessed via `<home_url>/glotpress/`
-# Manual Installation
+## Manual Installation
```bash
$ cd /your/wordpress/folder/wp-content/plugins/
$ git clone git@github.com:GlotPress/GlotPress-WP.git glotpress
```
After activating the plugin, GlotPress can be accessed via `<home_url>/glotpress/`
-# More Info
-
-More information can be found on the [GlotPress Wiki](https://github.com/GlotPress/GlotPress-WP/wiki/6.-The-Manual).
## Communication
* [GitHub Home](https://github.com/GlotPress/GlotPress-WP)
-* [Blog](http://blog.glotpress.org/)
+* [Blog](https://glotpress.blog)
* [WordPress Slack](https://chat.wordpress.org/): #glotpress (for development only)
-## Running Tests
+## More Info
-```bash
-$ ./tests/phpunit/bin/run-unittests.sh -d testdb_name [ -u dbuser ] [ -p dbpassword ] [ -h dbhost ] [ -x dbprefix ] [ -w wpversion ] [ -D (drop-db) ] [ -c coverage_file ] [ -f phpunit_filter ]
-```
+More information can be found on the [GlotPress Wiki](https://github.com/GlotPress/GlotPress-WP/wiki/) or [the manual](https://glotpress.blog/the-manual/).

0 comments on commit ccca66a

Please sign in to comment.