|
11 | 11 |
|
12 | 12 | ⚠️👷♀️ The code is now part of the Rasa repo https://github.com/RasaHQ/rasa. Please create any Pull Requests or Issues there. 👷♂️⚠️ |
13 | 13 |
|
14 | | -Rasa Core is a framework for building conversational software, which includes |
15 | | -chatbots on: |
16 | | -- Facebook Messenger |
17 | | -- Slack |
18 | | -- Microsoft Bot Framework |
19 | | -- Rocket.Chat |
20 | | -- Mattermost |
21 | | -- Telegram |
22 | | -- Twilio |
23 | | - |
24 | | -But you can also build assistants using: |
25 | | -- Alexa Skills |
26 | | -- Google Home Actions |
27 | | - |
28 | | -Rasa Core's primary purpose is to help you build contextual, layered |
29 | | -conversations with lots of back-and-forth. To have a real conversation, |
30 | | -you need to have some memory and build on things that were said earlier. |
31 | | -Rasa Core lets you do that in a scalable way. |
32 | | - |
33 | | -There's a lot more background information in this |
34 | | -[blog post](https://medium.com/rasa-blog/a-new-approach-to-conversational-software-2e64a5d05f2a). |
35 | | - |
36 | | ---- |
37 | | -- **What do Rasa Core & NLU do? 🤔** |
38 | | - [Read About the Rasa Stack](https://rasa.com/products/rasa-stack/) |
39 | | - |
40 | | -- **I'd like to read the detailed docs 🤓** |
41 | | - [Read The Docs](https://rasa.com/docs/core) |
42 | | - |
43 | | -- **I'm ready to install Rasa Core! 🚀** |
44 | | - [Installation](https://rasa.com/docs/core/installation/) |
45 | | - |
46 | | -- **I'm ready to start building! 🤖** |
47 | | - [Rasa Stack starter-pack](https://github.com/RasaHQ/starter-pack-rasa-stack) |
48 | | - |
49 | | -- **I have a question ❓** |
50 | | - [Rasa Community Forum](https://forum.rasa.com) |
51 | | - |
52 | | -- **I would like to contribute 🤗** |
53 | | - [How to contribute](#how-to-contribute) |
54 | | - |
55 | | ---- |
56 | | -## Where to get help |
57 | | - |
58 | | -There is extensive documentation: |
59 | | - |
60 | | -- [master](https://rasa.com/docs/core/master/) |
61 | | - (if you install from **github**) or |
62 | | -- [stable](https://rasa.com/docs/core) |
63 | | - (if you install from **pypi**) |
64 | | - |
65 | | - |
66 | | -Please use [Rasa Community Forum](https://forum.rasa.com) for quick answers to |
67 | | -questions. |
68 | | - |
69 | | - |
70 | | -### README Contents: |
71 | | -- [How to contribute](#how-to-contribute) |
72 | | -- [Development Internals](#development-internals) |
73 | | -- [License](#license) |
74 | | - |
75 | | -### How to contribute |
76 | | -We are very happy to receive and merge your contributions. There is |
77 | | -some more information about the style of the code and docs in the |
78 | | -[documentation](https://rasa.com/docs/contributing/). |
79 | | - |
80 | | -In general the process is rather simple: |
81 | | -1. create an issue describing the feature you want to work on (or |
82 | | - have a look at issues with the label |
83 | | - [help wanted](https://github.com/RasaHQ/rasa_core/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)) |
84 | | -2. write your code, tests and documentation |
85 | | -3. create a pull request describing your changes |
86 | | - |
87 | | -You pull request will be reviewed by a maintainer, who might get |
88 | | -back to you about any necessary changes or questions. You will |
89 | | -also be asked to sign a |
90 | | -[Contributor License Agreement](https://cla-assistant.io/RasaHQ/rasa_core). |
91 | | - |
92 | | - |
93 | | -## Development Internals |
94 | | -### Running and changing the documentation |
95 | | -To build & edit the docs, first install all necessary dependencies: |
96 | | - |
97 | | -``` |
98 | | -brew install sphinx |
99 | | -pip3 install -r dev-requirements.txt |
100 | | -``` |
101 | | - |
102 | | -After the installation has finished, you can run and view the documentation |
103 | | -locally using: |
104 | | -``` |
105 | | -make livedocs |
106 | | -``` |
107 | | - |
108 | | -Visit the local version of the docs at http://localhost:8000 in your browser. |
109 | | -You can now change the docs locally and the web page will automatically reload |
110 | | -and apply your changes. |
111 | | - |
112 | 14 | ## License |
113 | 15 | Licensed under the Apache License, Version 2.0. |
114 | 16 | Copyright 2019 Rasa Technologies GmbH. [Copy of the license](LICENSE.txt). |
|
0 commit comments