Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for developers #917

Closed
MichaelCurrin opened this issue Mar 5, 2021 · 1 comment
Closed

Add documentation for developers #917

MichaelCurrin opened this issue Mar 5, 2021 · 1 comment

Comments

@MichaelCurrin
Copy link

MichaelCurrin commented Mar 5, 2021

Hi, I recently came across in this project and am interested but found the docs experience limited, even for performing a few tasks to setup and run.

Fortunately I have experience with make and Go, so was able to figure some stuff out myself.

There is one item in docs on architecture.

@MichaelCurrin
Copy link
Author

MichaelCurrin commented Mar 5, 2021

What I am looking for is something like this, as notes for developers working on the project:

  • docs/installation.md
    # Installation
    
    ## Install system dependencies
     
    Install Go 1.16...
    
    (Install Node?)
    
    ## Clone
    
    Clone the repo:
    
        git clone git@github.com:evanw/esbuild.git.
    
  • docs/usage.md
    # Usage
    
    ## Tests
    
        make test
    
    ## Build
    
    Create binary in the current directory.
    
        make
    
    Test it:
    
        ./esbuild -h
    

Maybe some examples of how to run that command against some sample scripts to verify it is working.

That was from a Go perspective - maybe add something for JS developers - like how to Install Node and how to run and test some scripts in this project.

See also my generic Go project template for reference - it uses make heavily. https://github.com/MichaelCurrin/go-project-template/tree/main/docs

@MichaelCurrin MichaelCurrin changed the title Add dev docs Add documentation for developers Mar 5, 2021
@evanw evanw closed this as completed in 1ae3ca6 Dec 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant