question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add official dev docs for Windows

See original GitHub issue

🐞 What bugs you? Currently there are no detailed doc giving instructions as to how to set up a Windows PC for EinsteinPy development work.

🎯 Goal To develop a minimally viable set of instructions to set up Windows PC for EinsteinPy. This will allow users who does not have access to either a Mac or a Linux/Unix machine to contribute to EinsteinPy as well.

💡 Possible solutions We can use a copy of the Windows VM for testing out the instructions. (https://developer.microsoft.com/en-us/windows/downloads/virtual-machines/)

📋 Steps to solve the problem Try and replicate the instructions for existing setups and re-write documentation.

  • Comment below about what you’ve started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project 🎉

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:7 (2 by maintainers)

github_iconTop GitHub Comments

2reactions
rachittshahcommented, Nov 17, 2020

@kakirastern I would like to work on this

My approach -

  1. Concise windows centric doc
  2. Include an possible FAQ of all the possible errors that may arise
  3. Include relevant gifs of the error behaviour and how to resolve.
1reaction
JeS24commented, Jan 5, 2021

@godslayer201 Ping me, if you need to test something out. I mostly use Windows.

Also, CONTRIBUTING covers all aspects of EPy dev on Windows, except one. makefile won’t work natively on Windows. While WSL, Cygwin or MinGW can be used, the simplest way to build docs is to use sphinx-build -b html .\source\ .\build\. There are ways to convert makefile to make.bat, which too would work on Windows. Other than this, all other steps are identical across platforms.

Read more comments on GitHub >

github_iconTop Results From Across the Web

DevDocs API Documentation
Fast, offline, and free documentation browser for developers. Search 100+ docs in one web app: HTML, CSS, JavaScript, PHP, Ruby, Python, Go, C,...
Read more >
Windows Dev Docs (@WindowsDocs) / Twitter
Windows Dev Docs. @WindowsDocs. We're the official Windows developer documentation team at Microsoft, and we post about new docs and APIs.
Read more >
Latest updates to the Windows developer docs - Microsoft Learn
The Windows developer docs are regularly updated with new and improved information and content. Here is a summary of changes as of December ......
Read more >
A full-featured desktop app for DevDocs.io. - GitHub
A full-featured desktop app for DevDocs.io. Contribute to egoist/devdocs-desktop development by creating an account on GitHub.
Read more >
Featured | Apple Developer Documentation
Add rich documentation to your Swift and Objective-C app and library projects. ... New API. Desktop-class iPad apps. Leverage UIKit and SwiftUI enhancements ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found