Skip to content

Latest commit

 

History

History
202 lines (152 loc) · 5.79 KB

README-EN.md

File metadata and controls

202 lines (152 loc) · 5.79 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

track-map

Trace your footprint in this world

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Product Name Screen Shot

This project aims to help you record your footprint in the world in text format. The input for the screenshot is as the follows:

保山 99.1729 25.05753
南昌 115.9000015258789 28.864999771118164
烟台 121.37200164794922 37.40169906616211
沈阳 123.48300170898438 41.639801025390625

保山 南昌
烟台 沈阳
南昌 保山
烟台 沈阳
沈阳 烟台
烟台 沈阳

Built With

Getting Started

Clone the repository and enjoy.

Prerequisites

  1. install Node.js
  2. install ANTLR 4

Installation

  1. Clone the repo 
    git clone https://github.com/w158rk/track-map.git
  2. Install NPM packages 
    npm install
  3. Build the dist 
    npm run build

Usage

Run a http server in the dist/ directory. For example, you can run npx serve . in the dist.

Roadmap

  • ANTLR 4 support
  • location data for some major cities
  • high-quality image export
  • custom color setting

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

w158rk - wrk15835@outlook.com

Project Link: https://github.com/w158rk/track-map

Acknowledgements