Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
d99kris committed Dec 15, 2023
1 parent e3c2411 commit 533ead4
Showing 1 changed file with 34 additions and 54 deletions.
88 changes: 34 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,55 +106,61 @@ Supported Platforms
nmail is developed and tested on Linux and macOS. Current version has been
tested on:

- macOS Big Sur 11.0
- Ubuntu 20.04 LTS
- macOS Sonoma 14.0
- Ubuntu 22.04 LTS

Install using Package Manager
=============================

Build / Install
===============

Linux
macOS
-----
**Build / Install Stable Release**

**Dependencies Ubuntu**
brew tap d99kris/nmail
brew install nmail

Required:

sudo apt install git cmake build-essential libssl-dev libreadline-dev libncurses5-dev libxapian-dev libsqlite3-dev libsasl2-dev libsasl2-modules libcurl4-openssl-dev libexpat-dev zlib1g-dev libmagic-dev uuid-dev
Build from Source
=================
**Get Source**

Optional (to view/compose HTML emails):
git clone https://github.com/d99kris/nmail && cd nmail

sudo apt install pandoc
Using make.sh script
--------------------
If using macOS, Arch, Fedora, Gentoo, Raspbian or Ubuntu, one can use
the `make.sh` script provided.

**Dependencies Fedora**
**Dependencies**

Required:
./make.sh deps

sudo yum -y install cmake openssl-devel ncurses-devel xapian-core-devel sqlite-devel cyrus-sasl-devel cyrus-sasl-plain libcurl-devel expat-devel zlib-devel file-devel libuuid-devel clang
**Build / Install**

Optional (to view/compose HTML emails):
./make.sh build && ./make.sh install

sudo yum -y install pandoc
Manually
--------
**Dependencies**

**Dependencies Arch Linux**
macOS

Required:
brew install openssl ncurses xapian sqlite libmagic ossp-uuid

sudo pacman -Sy cmake make openssl ncurses xapian-core sqlite cyrus-sasl curl expat zlib file
Arch

Optional (to view/compose HTML emails):
sudo pacman -Sy cmake make openssl ncurses xapian-core sqlite cyrus-sasl curl expat zlib file pandoc

sudo pacman -Sy pandoc
Debian-based (Ubuntu, Raspbian, etc)

**Dependencies Common Linux**
sudo apt install git cmake build-essential libssl-dev libreadline-dev libncurses5-dev libxapian-dev libsqlite3-dev libsasl2-dev libsasl2-modules libcurl4-openssl-dev libexpat-dev zlib1g-dev libmagic-dev uuid-dev

Optional (for OAuth 2.0 support):
Fedora

pip3 install -U requests
sudo yum -y install cmake openssl-devel ncurses-devel xapian-core-devel sqlite-devel cyrus-sasl-devel cyrus-sasl-plain libcurl-devel expat-devel zlib-devel file-devel libuuid-devel clang pandoc

**Source**
Gentoo

git clone https://github.com/d99kris/nmail && cd nmail
sudo emerge -n dev-util/cmake dev-libs/openssl sys-libs/ncurses dev-libs/xapian dev-db/sqlite dev-libs/cyrus-sasl net-misc/curl dev-libs/expat sys-libs/zlib sys-apps/file

**Build**

Expand All @@ -164,36 +170,10 @@ Optional (for OAuth 2.0 support):

sudo make install

macOS
-----

**Dependencies**

Required:

brew install cmake openssl ncurses xapian sqlite libmagic ossp-uuid

Optional (for OAuth 2.0 support):
**Optional (for OAuth 2.0 support):**

pip3 install -U requests

Optional (to view/compose HTML emails):

brew install pandoc

**Source**

git clone https://github.com/d99kris/nmail && cd nmail

**Build**

mkdir -p build && cd build && cmake .. && make -s

**Install**

make install


Getting Started
===============

Expand Down

0 comments on commit 533ead4

Please sign in to comment.