|
|
@@ -49,44 +49,29 @@ And now, some example screenshots. Below them are instructions to get you start
|
49
|
49
|
If you just want to play around, you can simply clone this repository, then perform the following steps:
|
50
|
50
|
|
51
|
51
|
* Copy `.env.example` to `.env` (`cp .env.example .env`) and edit `.env`, at least updating the `APP_SECRET_TOKEN` variable.
|
52
|
|
-* Run `rake db:create`, `rake db:migrate`, and then `rake db:seed` to create a development MySQL database with some example seed data.
|
|
52
|
+* Run `rake db:create`, `rake db:migrate`, and then `rake db:seed` to create a development MySQL database with some example Agents.
|
53
|
53
|
* Run `foreman start`, visit [http://localhost:3000/][localhost], and login with the username of `admin` and the password of `password`.
|
54
|
54
|
* Setup some Agents!
|
|
55
|
+* Read the [wiki][wiki] for usage examples and to get started making new Agents.
|
55
|
56
|
|
56
|
57
|
Note: by default, emails are not sent in the `development` Rails environment, which is what you just setup. If you'd like to enable emails when playing with Huginn locally, edit `config.action_mailer.perform_deliveries` in `config/environments/development.rb`.
|
57
|
58
|
|
58
|
59
|
If you need more detailed instructions, see the [Novice setup guide][novice-setup-guide].
|
59
|
60
|
|
60
|
61
|
[localhost]: http://localhost:3000/
|
|
62
|
+[wiki]: https://github.com/cantino/huginn/wiki
|
61
|
63
|
[novice-setup-guide]: https://github.com/cantino/huginn/wiki/Novice-setup-guide
|
62
|
64
|
|
63
|
|
-### Real Start
|
64
|
|
-
|
65
|
|
-Follow these instructions if you wish to deploy your own version of Huginn or contribute back to the project. GitHub doesn't make it easy to work with private forks of public repositories, so I recommend that you follow the following steps:
|
66
|
|
-
|
67
|
|
-* Make a public fork of Huginn. If you can't create private GitHub repositories, you can skip the steps below. Just follow the *Quick Start* steps above and make pull requests when you want to contribute a patch.
|
68
|
|
-* Make a private, empty GitHub repository called `huginn-private`
|
69
|
|
-* Duplicate your public fork into your new private repository (via [GitHub's instructions](https://help.github.com/articles/duplicating-a-repository)):
|
70
|
|
-
|
71
|
|
- git clone --bare git@github.com:you/huginn.git
|
72
|
|
- cd huginn.git
|
73
|
|
- git push --mirror git@github.com:you/huginn-private.git
|
74
|
|
- cd .. && rm -rf huginn.git
|
75
|
|
-
|
76
|
|
-* Checkout your new private repository.
|
77
|
|
-* Add your Huginn public fork as a remote to your new private repository (`huginn-private`):
|
78
|
|
-
|
79
|
|
- git remote add public git@github.com:you/huginn.git
|
80
|
|
-
|
81
|
|
-* Run the steps from *Quick Start* above to configure your copy of Huginn.
|
82
|
|
-* When you want to contribute patches, do a remote push from your private repository to your public fork of the relevant commits, then make a pull request to this repository.
|
83
|
|
-
|
84
|
65
|
## Deployment
|
85
|
66
|
|
86
|
67
|
Please see [the Huginn Wiki](https://github.com/cantino/huginn/wiki#deploying-huginn) for detailed deployment strategies for different providers.
|
87
|
68
|
|
88
|
69
|
### Optional Setup
|
89
|
70
|
|
|
71
|
+#### Setup for private development
|
|
72
|
+
|
|
73
|
+See [private development instructions](https://github.com/cantino/huginn/wiki/Private-development-instructions) on the wiki.
|
|
74
|
+
|
90
|
75
|
#### Enable the WeatherAgent
|
91
|
76
|
|
92
|
77
|
In order to use the WeatherAgent you need an [API key with Wunderground](http://www.wunderground.com/weather/api/). Signup for one and then change value of `api_key: your-key` in your seeded WeatherAgent.
|