Add proper README

Signed-off-by: Philippe Ombredanne <[email protected]>

README.rst

@@ -1,62 +1,31 @@
-A Simple Python Project Skeleton
-================================
-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.
+=========================================
+MatchCode approximate code search tests
+=========================================
 
-.. _blog post: https://blog.jaraco.com/a-project-skeleton-for-python-projects/
+This repository is a test suite for approximate code search including AI-generated code search.
 
+- Homepage: https://github.com/aboutcode-org/matchcode-tests/
+- Related repos:
 
-Usage
-=====
-
-A brand new project
--------------------
-.. code-block:: bash
-
-    git init my-new-repo
-    cd my-new-repo
-    git pull [email protected]:nexB/skeleton
+  - https://github.com/aboutcode-org/purldb
+  - https://github.com/aboutcode-org/matchcode-toolkit
+  - https://github.com/aboutcode-org/ai-gen-code-search
 
-    # Create the new repo on GitHub, then update your remote
-    git remote set-url origin [email protected]: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 [email protected]:nexB/skeleton
-    git fetch skeleton
-    git merge skeleton/main --allow-unrelated-histories
+Usage
+=====
 
-This is also the workflow to use when updating the skeleton files in any given repository.
+- Clone this repository
+- In the clone, run ``make dev``
+- run ``. venv/bin/activate``
+- run the full test suite with::
 
-More usage instructions can be found in ``docs/skeleton-usage.rst``.
+    pytest -vvs tests
 
+This is designed to run only on Linux.
 
-Release Notes
+License
 =============
 
-- 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.
+- the data is under a CC-BY-4.0 license
+- the code is under the Apache-2.0 license