diff --git a/README.rst b/README.rst index 6cbd839..79aeec2 100644 --- a/README.rst +++ b/README.rst @@ -1,62 +1,16 @@ -A Simple Python Project Skeleton +Go-Inspector ================================ -This repo attempts to standardize the structure of the Python-based project's -repositories using modern Python packaging and configuration techniques. -Using this `blog post`_ as inspiration, this repository serves as the base for -all new Python projects and is mergeable in existing repositories as well. -.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/ +- To enable the GoReSym plugin, first you need to install goresym from https://github.com/mandiant/GoReSym/releases/download/v2.6.4/GoReSym.zip +- Unzip the GoReSym.zip, extract goresym for linux and add it in src/go_inspector/bin. +- then change it to executable ```chmod u+x src/go_inspector/bin/GoReSym_lin``` +- Install requirements and dependencies using ```make dev``` +- Use ```scancode --json-pp - --go-symbol --verbose``` to get debug symbols. -Usage -===== +How to generate test binaries +============================ -A brand new project -------------------- -.. code-block:: bash - - git init my-new-repo - cd my-new-repo - git pull git@github.com:nexB/skeleton - - # Create the new repo on GitHub, then update your remote - git remote set-url origin git@github.com:nexB/your-new-repo.git - -From here, you can make the appropriate changes to the files for your specific project. - -Update an existing project ---------------------------- -.. code-block:: bash - - cd my-existing-project - git remote add skeleton git@github.com:nexB/skeleton - git fetch skeleton - git merge skeleton/main --allow-unrelated-histories - -This is also the workflow to use when updating the skeleton files in any given repository. - -More usage instructions can be found in ``docs/skeleton-usage.rst``. - - -Release Notes -============= - -- 2023-07-18: - - Add macOS-13 job in azure-pipelines.yml - -- 2022-03-04: - - Synchronize configure and configure.bat scripts for sanity - - Update CI operating system support with latest Azure OS images - - Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party dependencies - There are now fewer scripts. See etc/scripts/README.rst for details - -- 2021-09-03: - - ``configure`` now requires pinned dependencies via the use of ``requirements.txt`` and ``requirements-dev.txt`` - - ``configure`` can now accept multiple options at once - - Add utility scripts from scancode-toolkit/etc/release/ for use in generating project files - - Rename virtual environment directory from ``tmp`` to ``venv`` - - Update README.rst with instructions for generating ``requirements.txt`` and ``requirements-dev.txt``, - as well as collecting dependencies as wheels and generating ABOUT files for them. - -- 2021-05-11: - - Adopt new configure scripts from ScanCode TK that allows correct configuration of which Python version is used. +- Run `go tool dist list` to get all possible pairs of OSes and arches to compile the binary. +- Then use a OS/arch pair like this ``GOOS= GOARCH= go build -o ./tests/data/app_exe ./tests/data/main.go`` + to get compiled binary. diff --git a/tests/data/main.go b/tests/data/main.go new file mode 100644 index 0000000..8da69cc --- /dev/null +++ b/tests/data/main.go @@ -0,0 +1,11 @@ +package main + +import ( + "fmt" + "path/filepath" +) + +func main() { + s := filepath.Join("a", "b", "c") + fmt.Println(s) +}