Skip to content

Commit 26f0660

Browse files
Merging in README additions. (#42)
* Merging in README additions. * Update README.md - Cleaned up to have consistent styling - We should not use both `# Header` and `Header\n====` - Similar with italics and code blocks * Updating tweak. --------- Co-authored-by: Brad Erickson <bbwe24@gmail.com>
1 parent 8417975 commit 26f0660

File tree

1 file changed

+36
-13
lines changed

1 file changed

+36
-13
lines changed

README.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ repository has a series of prototypes to confirm we can:
3434

3535
* collect the data we want;
3636
* extract what we need from it; and
37-
* route it to where we want it to go (there's *a lot* of data, with
37+
* route it to where we want it to go (there's _a lot_ of data, with
3838
complex dependencies, so this is actually a nontrivial problem)
3939

4040
Which mitigates most of the technical risk. We also now integrate with
@@ -43,40 +43,46 @@ a few prototype dashboards.
4343

4444
For this to be useful, we'll need to provide some basic documentation
4545
for developers to be able to navigate this repo (in particular,
46-
explaining *why* this approach works).
46+
explaining _why_ this approach works).
4747

48-
This system is designed to be *massively* scalable, but it is not
48+
This system is designed to be _massively_ scalable, but it is not
4949
currently implemented to be so (mostly for trivial reasons;
5050
e.g. scaffolding code which uses static files as a storage model). It
5151
will take work to flush out all of these performance issues, but we'd
5252
like to do that work once we better understand what we're doing and
5353
that the core approach and APIs are correct.
5454

55-
Getting Started
56-
===============
55+
## Getting Started
5756

5857
As an early prototype, getting started isn't seamless. Run:
5958

60-
~~~~~
59+
```~bash
6160
make install
62-
~~~~~
61+
```
6362

6463
And follow the instructions. You'll probably run into bugs. Work around the bugs. Then fix up the makefile and make a PR to address those bugs :)
6564

6665
Once that's done, run:
6766

68-
~~~~
67+
```bash
6968
make
70-
~~~~
69+
```
7170

7271
Again, fix up the makefile, and make a PR.
7372

7473
You can also go into the devops directory, which has scripts in
7574
progress for spinning up a cloud instance and managing flocks of
7675
_Learning Observer_ instances.
7776

78-
System requirements
79-
===================
77+
### Installing Writing Observer
78+
79+
To setup writing_observer on top of the learning observer platform you must go into modules/writing_observer and run:
80+
81+
```bash
82+
sudo python setup.py develop
83+
```
84+
85+
### System requirements
8086

8187
It depends on what you're planning to use the system for.
8288

@@ -97,8 +103,25 @@ All _Learning Observer_ development has been on Linux-based platforms
97103
(including Ubuntu and RHEL). There are folks outside of the core team
98104
who have tried to run it on Mac or on WSL, with mixed success.
99105

100-
Contributing or learning more
101-
=============================
106+
Running on RHEL requires the following services:
107+
108+
* REDIS
109+
* nginx.
110+
111+
#### bcrypt
112+
113+
A note on bcrypt. The code uses bcrypt for some internal password management.
114+
We are not including it directly in the install because it acts oddly across
115+
platforms so you may need to install some version manually.
116+
117+
#### Additional Notes
118+
119+
At present the system also uses static content that is served from a repo.
120+
This allows us to actually select different sources for the static data.
121+
This can also point to the current copy if necessary and can be configured
122+
as part of the creds.yaml file to generate the repo or add it on startup.
123+
124+
## Contributing or learning more
102125

103126
We're still a small team, and the easiest way is to shoot us a quick
104127
email. We'll gladly walk you through anything you're interested in.

0 commit comments

Comments
 (0)