From 17a0f11ffdb77ca5b40d1370426baec0ab9a644d Mon Sep 17 00:00:00 2001 From: Adam Mathes Date: Sat, 7 Jul 2018 09:02:06 -0700 Subject: doc updates --- README.md | 41 ++++++--- readme.html | 302 ++++++++++++++++++++++++++++++++++-------------------------- 2 files changed, 196 insertions(+), 147 deletions(-) diff --git a/README.md b/README.md index af79934..c0e4dd5 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ 
-                     ▄▄                 
-                     ██                 
- ██▄████▄   ▄████▄   ██ ▄██▀    ▄████▄  
- ██▀   ██  ██▄▄▄▄██  ██▄██     ██▀  ▀██ 
- ██    ██  ██▀▀▀▀▀▀  ██▀██▄    ██    ██ 
- ██    ██  ▀██▄▄▄▄█  ██  ▀█▄   ▀██▄▄██▀ 
- ▀▀    ▀▀    ▀▀▀▀▀   ▀▀   ▀▀▀    ▀▀▀▀   
-                                        
-                                        
-
-              v0.2 manual
+                     ██
+                     ██
+                     ██
+ ██░████    ░████▒   ██  ▓██▒   ░████░
+ ███████▓  ░██████▒  ██ ▓██▒   ░██████░
+ ███  ▒██  ██▒  ▒██  ██▒██▒    ███  ███
+ ██    ██  ████████  ████▓     ██░  ░██
+ ██    ██  ████████  █████     ██    ██
+ ██    ██  ██        ██░███    ██░  ░██
+ ██    ██  ███░  ▒█  ██  ██▒   ███  ███
+ ██    ██  ░███████  ██  ▒██   ░██████░
+ ██    ██   ░█████▒  ██   ███   ░████░
+
+             v0.2 manual
                7/4/2018
+ **Table of Contents** @@ -21,6 +25,7 @@ - [Installation](#installation) - [Requirements](#requirements) - [Building](#building) + - [Dependencies](#dependencies) - [Configuration](#configuration) - [Storage](#storage) - [Usage](#usage) @@ -67,11 +72,19 @@ Backend is written in `Go` and there is a simple javascript frontend and cat ear ## Requirements - * [Go](https://golang.org) - * [SQLite](https://sqlite.org/) - +If you are using a binary, no dependencies! + +NOTE: I haven't put up any binaries yet. + ## Building +### Dependencies + + * [Go](https://golang.org) + * [go-sqlite3](https://github.com/mattn/go-sqlite3) + * [sqlite](https://sqlite.org/index.html) + * [gcc](https://gcc.gnu.org) + $ go get adammathes.com/neko This will download `neko`, dependencies, and build them all in `$GOPATH/src/`. By default this should be something like `$HOME/go/src/`. diff --git a/readme.html b/readme.html index 573e5cc..ee26788 100644 --- a/readme.html +++ b/readme.html @@ -1,124 +1,132 @@ -
-                     ▄▄                 
-                     ██                 
- ██▄████▄   ▄████▄   ██ ▄██▀    ▄████▄  
- ██▀   ██  ██▄▄▄▄██  ██▄██     ██▀  ▀██ 
- ██    ██  ██▀▀▀▀▀▀  ██▀██▄    ██    ██ 
- ██    ██  ▀██▄▄▄▄█  ██  ▀█▄   ▀██▄▄██▀ 
- ▀▀    ▀▀    ▀▀▀▀▀   ▀▀   ▀▀▀    ▀▀▀▀   
-                                        
-                                        
-
-              v0.2 manual
+
+                     ██
+                     ██
+                     ██
+ ██░████    ░████▒   ██  ▓██▒   ░████░
+ ███████▓  ░██████▒  ██ ▓██▒   ░██████░
+ ███  ▒██  ██▒  ▒██  ██▒██▒    ███  ███
+ ██    ██  ████████  ████▓     ██░  ░██
+ ██    ██  ████████  █████     ██    ██
+ ██    ██  ██        ██░███    ██░  ░██
+ ██    ██  ███░  ▒█  ██  ██▒   ███  ███
+ ██    ██  ░███████  ██  ▒██   ░██████░
+ ██    ██   ░█████▒  ██   ███   ░████░
+
+             v0.2 manual
                7/4/2018
 

 
 
-
-
 
 
Table of Contents

 
 
+
  • Installation
 
 
-
    • 
-
  • Configuration
+
  • Requirements
    • 
+
  • Building
 
 
-
    • 
-
  • Usage
+
  • Dependencies
    • 
+
+
+
  • Configuration
 
 
-
    • 
-
  • All Command Line Options
    • 
-
  • TODO
    • 
-
  • History
+
  • Storage
    • 
+
+
  • Usage
 
 
-
    • 
-
  • Feedback
    • 
-
+
  • Web Interface
    • 
+
  • Add Feed
    • 
+
  • Crawl Feeds
    • 
+
  • Export
    • 
+
+
  • All Command Line Options
    • 
+
  • TODO
    • 
+
  • History
 
-
-
+
    • 
+
  • Feedback
    • 
+
 
 
-
    Neko
    
+
    
+Neko
    
 
 
    neko is a self-hosted, rss reader focused on simplicity and efficiency.
    
 
 
    Backend is written in Go and there is a simple javascript frontend and cat ears.
    
 
 
    note: the cat ears are in your mind
    
-
-
    Features
    
+
    
+Features
    
 
 
      
-
    •  limited features (#1 feature)
      • 
-
    •  keyboard shortcuts
+
    • limited features (#1 feature)
      • 
+
    • keyboard shortcuts
 
 
        
 
      • j - next item
        • 
 
      • k - previous item
        • 
-
      • that’s all you should ever need
        • 
-
      
-
      • 
-
    •  automatically marks items read in an infinite stream of never-ending content (until you run out of content and it ends)
      • 
+
    • that's all you should ever need
      • 
+
    
+
  • automatically marks items read in an infinite stream of never-ending content (until you run out of content and it ends)
    • 
+
  • full text search
    • 
+
  • scrapes full text of pages on demand
    • 
 
+
    
+Screenshots
    
 
+
    Screenshot 1
    
 
-
    Screenshots
    
+
    Screenshot 2
    
+
    
+Installation
    
+
    
+Requirements
    
 
-
    Screenshot 1
    
+
    If you are using a binary, no dependencies!
    
 
-
    Screenshot 2
    
+
    NOTE: I haven't put up any binaries yet.
    
+
    
+Building
    
+
    
+Dependencies
    
 
-
    Installation
    
+
 
 
    This will download neko, dependencies, and build them all in $GOPATH/src/. By default this should be something like $HOME/go/src/.
    
 
 
    A neko binary should now be in $GOPATH/bin/. By default this is usually $HOME/go/bin/
    
+
    
+Configuration
    
 
-
    Configuration
    
-
-
    There’s no configuration file – everything is handled with a few command line flags. You shouldn’t need to change the defaults most of the time.
    
-
-
    Storage
    
+
    There's no configuration file -- everything is handled with a few command line flags. You shouldn't need to change the defaults most of the time.
    
+
    
+Storage
    
 
 
    By default neko will create the file neko.db in the current directory for storage.
    
 
@@ -127,48 +135,53 @@
 
    $ neko --database=/var/db/neko.db --add=http://trenchant.org/rss.xml
 
    
 
-
    For expert users – this is a SQLite database and can be manipulated with standard sqlite commands.
    
+
    For expert users -- this is a SQLite database and can be manipulated with standard sqlite commands --
    
 
-
    Usage
    
+
    $ sqlite3 neko.db .schema
+
    
 
-
    Web Interface
    
+
    -- will print out the database schema.
    
+
    
+Usage
    
+
    
+Web Interface
    
 
 
    You can do most of what you need to do with neko from the web interface, which is what neko does by default.
    
 
 
    $ neko
 
    
 
-
    neko web interface should now be available at 127.0.0.1:4994 – opening a browser up to that should show you the interface.
    
+
    neko web interface should now be available at 127.0.0.1:4994 -- opening a browser up to that should show you the interface.
    
 
 
    You can specify a different port using the --http option.
    
 
 
    $ neko --http=9001
 
    
 
-
    If you are hosting on a publicly available server instead of a personal computer, you can protect the interface with a password flag –
    
+
    If you are hosting on a publicly available server instead of a personal computer, you can protect the interface with a password flag --
    
 
 
    $ neko --password=rssisveryimportant
 
    
+
    
+Add Feed
    
 
-
    Add Feed
    
-
-
    You can add feeds directly from the command line for convenience –
    
+
    You can add feeds directly from the command line for convenience --
    
 
 
    $ neko --add=http://trenchant.org/rss.xml
 
    
+
    
+Crawl Feeds
    
 
-
    Crawl Feeds
    
-
-
    By default neko will crawl your feeds every 60 minutes while the interface is running, but if you want to manually crawl from the command line –
    
+
    Update feeds from the command line with --
    
 
 
    $ neko --update
 
    
 
 
    This will fetch, download, parse, and store in the database your feeds.
    
+
    
+Export
    
 
-
    Export
    
-
-
    Export de facto RSS feed standard OPML from the command line with –
    
+
    Export de facto RSS feed standard OPML from the command line with --
    
 
 
    $ neko --export=opml
 
    
@@ -178,8 +191,8 @@
 
    Export is also available in the web interface.
    
 
 
    Import of OPML and other things is a TODO item.
    
-
-
    All Command Line Options
    
+
    
+All Command Line Options
    
 
 
    View all command line options with -h or --help
    
 
@@ -187,62 +200,85 @@

    Usage of neko: - -a, –add http://example.com/rss.xml - add the feed at URL http://example.com/rss.xml - -d, –database string - sqlite database file (default “neko.db”) - -x, –export string - export feed. format required: text, json or opml - -h, –help - print usage information - -s, –http int - HTTP port to serve on (default 4994) - -i, –imageproxy - rewrite and proxy all image requests for privacy (experimental) - -m, –minutes int - minutes between crawling feeds (default 60) - -p, –password string - password to access web interface - -u, –update - fetch feeds and store new items - -v, –verbose - verbose output

    - -

    TODO

    + -a, --add http://example.com/rss.xml

    - +
        add the feed at URL http://example.com/rss.xml
+
    +

    -d, --database string

    -

    History

    +
        sqlite database file (default "neko.db")
+
    -

    Early 2017

    +

    -x, --export string

    -

    I decided I didn’t like the original version of this that was python and mongo so rewrote it. I wanted to learn some Go. So assume the code is not great since I don’t know what I’m doing even more so than normal.

    +
        export feed. format required: text, json or opml
+
    -

    The Javascript frontend is still the same, I keep saying I will rewrite that too since it’s old backbone.js code but it still seems to mostly work. It’s not very pretty though.

    +

    -h, --help

    -

    July 2018 – v0.2

    +
        print usage information
+
    -

    Significant changes to simplify setup, configuration, usage. The goal was typing neko should be all you need to do to get started and use the software.

    +

    -s, --http int

    + +
        HTTP port to serve on (default 4994)
+
    + +

    -i, --imageproxy

    + +
        rewrite and proxy all image requests for privacy (experimental)
+
    + +

    -p, --password string

    + +
        password to access web interface
+
    + +

    -u, --update

    + +
        fetch feeds and store new items
+
    + +

    -v, --verbose

    + +
        verbose output
+
    +

    +TODO

    +

    +History

    +

    +Early 2017

    + +

    I decided I didn't like the original version of this that was python and mongo so rewrote it. I wanted to learn some Go. So assume the code is not great since I don't know what I'm doing even more so than normal.

    + +

    The Javascript frontend is still the same, I keep saying I will rewrite that too since it's old backbone.js code but it still seems to mostly work. It's not very pretty though.

    +

    +July 2018 -- v0.2

    +

    Significant changes to simplify setup, configuration, usage. The goal was typing neko should be all you need to do to get started and use the software.

    -

    Feedback

    + +

    +Feedback

    -

    Pull requests and issues are welcomed at https://github.com/adammathes/snkt

    +

    Pull requests and issues are welcomed at https://github.com/adammathes/neko

    + \ No newline at end of file -- cgit v1.2.3