Skip to content

docs: add a getting started guide to the main README #123

Description

@EmperorOrokuSaki
  • add a getting started guide to the main readme that covers how to use the CLI, and also the TUI through the cli
    • Basic usage is either adding --tui to the end of a obfuscate in cli, or using azoth obfuscate ... --emit-debug file and azoth tui debug_file
  • add a description of the commands available on the cli but not in as much depth as the cli readme itself, link to that for more info

@claude

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocsImprovements to documentationEasyGood for newcomers and ClaudeUnimportantNice to have but not urgent

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions