Skip to content

installation

keinsell edited this page Jan 24, 2025 · 1 revision

Installation

Neuronek is a modern terminal application currently in active development. This guide provides installation methods for early adopters and developers interested in experimenting with pre-release builds.

Installation Types

Type Description More Information
Precompiled Binaries Ready-to-run executables Jump to section
Package Managers Future system package integrations Jump to section
Source Compilation Build from latest code Jump to section

System Requirements

  • OS: Windows 10+, macOS 12+, Linux (kernel 5.4+)
  • Disk Space: 50MB minimum
  • Memory: 256MB RAM

Before You Begin

Installation Type Prerequisites Notes
Precompiled Binaries PowerShell 5+ or Bash Admin rights may be required
Source Compilation Rust 1.70+, Cargo, build essentials Internet connection required

Installation Steps

Precompiled Binaries

  1. Visit GitHub Releases
  2. Download appropriate package for your OS:
    • Windows: neuronek-x86_64-pc-windows-msvc.zip
    • Linux: neuronek-x86_64-unknown-linux-gnu.tar.gz
    • macOS: neuronek-x86_64-apple-darwin.zip
# Example Linux installation
tar xzf neuronek-x86_64-unknown-linux-gnu.tar.gz
sudo install neuronek /usr/local/bin/

Package Managers

> [!WARNING]
> Official package manager support is planned but not yet available.
> Check this space for future updates!

Source Compilation

# Install latest development version
cargo install --git https://github.com/keinsell/neuronek.git

# Install specific version
cargo install --git https://github.com/keinsell/neuronek.git --tag v0.0.1-alpha.1

Verify Installation

neuronek --version
# Should display: neuronek 0.0.1-alpha.1

Post-Installation

Configuration

After successful installation, see Reference Documentation for configuration options.

Updating

# For source installations
cargo install --git https://github.com/keinsell/neuronek.git --force

Troubleshooting

"Command not found" after installation

Solution: Ensure installation directory is in your PATH:

echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Build failures from source

Common causes:

  • Missing Rust toolchain
  • Outdated cargo version

Solution:

rustup update
cargo clean
cargo build

Version History

Version Release Date Status
v0.0.1-alpha.1 2023-11-15 Preview

Terms

Term Meaning
Trunk branch Main development branch
Cargo Rust package manager